org.eclipse.vtp.framework.interactions.core.configurations
Class InputConfiguration

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.configurations.InputConfiguration

All Implemented Interfaces:

IConfiguration, InteractionsConstants

public class InputConfiguration
extends java.lang.Object
implements IConfiguration, InteractionsConstants

InputConfiguration.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.core.configurations.InteractionsConstants

NAME_CHOICE, NAME_CHOICES, NAME_CONTENT_TYPE, NAME_DATA_NAME, NAME_DATA_REQUEST, NAME_FORMATTER, NAME_ID, NAME_INPUT, NAME_INPUT_ITEM, NAME_INPUT_NAME, NAME_INPUT_REQUEST, NAME_INTERACTION_TYPE, NAME_KEY, NAME_LANGUAGE, NAME_LOCALE, NAME_MEDIA, NAME_MEDIA_PROVIDER, NAME_MEDIA_PROVIDER_BINDING, NAME_META_DATA, NAME_META_DATA_ITEM, NAME_META_DATA_SET, NAME_NAME, NAME_OUTPUT, NAME_OUTPUT_ITEM, NAME_OUTPUT_MESSAGE, NAME_OUTPUT_NAME, NAME_PROPERTY, NAME_PROPERTY_ITEM, NAME_RESOURCE_MANAGER, NAME_SCRIPT, NAME_SCRIPTING_LANGUGAGE, NAME_SELECTION_REQUEST, NAME_SHARED_CONTENT, NAME_TRANSFER_MESSAGE, NAME_TYPE, NAME_VALUE, NAMESPACE_URI

Constructor Summary

InputConfiguration(IInputGrammarFactory inputFactory)
Creates a new InputConfiguration.

Method Summary

InputGrammar	getItem(java.lang.String brandName, java.lang.String interactionTypeID, java.lang.String languageID) Returns the item configured for the specified brand, interaction type, and language or null if no such item is configured.
void	load(org.w3c.dom.Element configurationElement) Loads the configuration information from the specified XML element.
void	save(org.w3c.dom.Element configurationElement) Saves the configuration information into the supplied XML element.
void	setItem(java.lang.String key, InputGrammar item) Sets the item configured for the specified brand, interaction type, and language.
void	setItem(java.lang.String brandName, java.lang.String interactionTypeID, java.lang.String languageID, InputGrammar item) Sets the item configured for the specified brand, interaction type, and language.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputConfiguration

public InputConfiguration(IInputGrammarFactory inputFactory)

Creates a new InputConfiguration.

Parameters:

inputFactory - The input factory to use.

Method Detail

getItem

public InputGrammar getItem(java.lang.String brandName,
                            java.lang.String interactionTypeID,
                            java.lang.String languageID)

Returns the item configured for the specified brand, interaction type, and language or null if no such item is configured.

Parameters:

brandName - The path of the brand to find the item for.

interactionTypeID - The ID of the interaction type to find the item for.

languageID - The ID of the language to find the item for.

Returns:

The item configured for the specified brand, interaction type, and language or null if no such item is configured.

setItem

public void setItem(java.lang.String brandName,
                    java.lang.String interactionTypeID,
                    java.lang.String languageID,
                    InputGrammar item)

Sets the item configured for the specified brand, interaction type, and language.

Parameters:

brandName - The path of the brand to set the item for.

interactionTypeID - The ID of the interaction type to set the item for.

languageID - The ID of the language to set the item for.

item - The item to set as the configuration or null to remove the specified configuration.

setItem

public void setItem(java.lang.String key,
                    InputGrammar item)

Sets the item configured for the specified brand, interaction type, and language.

Parameters:

key - The key to set the item for.

item - The item to set as the configuration or null to remove the specified configuration.

load

public void load(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Loads the configuration information from the specified XML element.

Specified by:

load in interface IConfiguration

Parameters:

configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Saves the configuration information into the supplied XML element.

Specified by:

save in interface IConfiguration

Parameters:

configurationElement - The element to save the configuration to.